home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d12 / e10_edit.arc / E.DOC < prev    next >
Text File  |  1990-03-22  |  12KB  |  254 lines

  1. Thanks for downloading E!
  2.  
  3. E is a small, fast, general purpose editor.  It is copyrighted but you are
  4. hereby granted a limited license to use it free of charge.
  5. While I am not aware of any bugs, I make no guarantees
  6. about its trustworthiness, so use it at your own risk.  Feel free to share it
  7. with others.  I only ask that you distribute these files together and unchanged
  8. and charge nothing for them.
  9.  
  10. Some of e's features:
  11.  
  12.   - block and line move and delete functions, to/from buffer or another file
  13.  
  14.   - find, replace, replace all
  15.  
  16.   - set tabs, L and R margins, word wrap, autoindent
  17.  
  18.   - set and jump to labels or line number
  19.  
  20.   - shell to DOS, one-key execution of batch files
  21.  
  22.   - DESQview-compatible (run in a window with direct write disabled)
  23.  
  24.   - assembly language (TASM) for speed and compactness, source included
  25.  
  26.   - configuration program included to change defaults
  27.  
  28.  
  29. Lines are limited to 80 chars in length.  Longer lines in input files are
  30. truncated.  Those entered at the terminal are wrapped at 80 characters.  Tab
  31. characters encountered as a file is being read in are converted to spaces using
  32. the current tab setting.
  33.  
  34. Here is a summary of commands.  In the descriptions of these commands, '*'
  35. indicates that the function performs differently if the shift key is down.
  36. When in E, press F1 for help.  Whenever you are asked to enter a response to a
  37. prompt (as for a string to find or file name), just pressing Enter will usually
  38. cancel the command.
  39.  
  40.  
  41. Cursor movement:
  42.  
  43. left                    left arrow, Ctrl S
  44. right                   right arrow, Ctrl D
  45. word left               Ctrl left arrow, Ctrl A
  46. word right              Ctrl right arrow, Ctrl F
  47. tab right               Tab
  48. tab left                Shift Tab
  49. to left margin          Home
  50. to end of line          End
  51. up                      up arrow, Ctrl E
  52. down                    down arrow, Ctrl X
  53. page up                 PgUp, Ctrl R
  54. page down               PgDn, Ctrl C
  55. start of file           Ctrl PgUp
  56. end of file             Ctrl PgDn
  57. assign label (0-9)      Alt L
  58. go to label (0-9)       Alt G
  59. jump to line #          Alt J
  60.  
  61.  
  62. Insert and Delete:
  63.  
  64. delete char left        backspace
  65. delete char at cursor   Del
  66. delete word left        Ctrl [
  67. delete word right       Ctrl ]
  68. delete to end of line   Ctrl \
  69. delete line             Ctrl -, Ctrl Y
  70. undelete line           Ctrl ^
  71.     'Delete to end of line' and 'delete line' save the deleted text in a
  72.     buffer.  Use Ctrl ^ to retrieve one line at a time.  The same buffer is
  73.     used for block deletes, providing an easy way to move a few lines:  delete
  74.     the lines individually using Ctrl -, move the cursor to the new location,
  75.     then insert all the lines at once using Alt I (see below).  If the cursor
  76.     is at the left margin when a line is undeleted using Ctrl ^, the line is
  77.     inserted above the current line.  If it is to the right of the left margin
  78.     it overwrites what is currently on the line from that column on.  This is
  79.     useful for moving comments from the end of one line to another.
  80. toggle insert mode      Ins
  81.     Toggle between Insert (the default, signified by a line cursor) and
  82.     Overwrite (identified by a block cursor) modes of text entry.
  83. insert raw character    Alt = *
  84.     Insert the character which follows, which might otherwise be interpreted as
  85.     a command (for example a form feed character).  If shifted, 80h is added to
  86.     the character.  For example, to enter line drawing characters, press Shift
  87.     Alt =, then a character in the set {@, A-J}.  Warning: don't start a line
  88.     with a character whose ASCII value is > 80h (E uses that bit as a flag when
  89.     moving buffered lines during a file swap).
  90.  
  91.  
  92. Insert and Delete Block and File:
  93.  
  94. mark start of block       Alt B
  95. copy block to buffer      Alt C *
  96. delete block to buffer    Alt D *
  97. insert block from buffer  Alt I *
  98. empty block buffer        Alt E *
  99. unmark                    Alt U
  100.     Alt C copies all marked lines (between the line where you pressed Alt B for
  101.     'mark start of block' and the present cursor location) to a buffer, or if
  102.     the shift key is also down, to a file.  Alt D deletes the original lines
  103.     after first copying them to the buffer or file.  Alt I inserts the contents
  104.     of the file or buffer above the present line.  Press Alt I several times to
  105.     insert multiple copies.  To move text, use Alt D then Alt I.  To move text
  106.     between two files, delete or copy to the block buffer, press Alt O to
  107.     change files, then Alt I to insert.  You can get lines into the buffer
  108.     using either Alt C or Alt D or the line delete commands Ctrl - or Ctrl \
  109.     and out using either Alt I or Ctrl ^.
  110.  
  111.     All block commands marked with a '*' will read from or write to a file
  112.     instead of an internal buffer if the shift key is down (you will be
  113.     prompted for a file name).  Here's a useful trick:  to print part of a
  114.     file, first mark the start of the block with Alt B, then use Shift Alt C
  115.     and give 'prn' as the file name.
  116.  
  117.     The block commands work on whole lines only.  To move part of a line, use
  118.     the Enter key to break it into pieces first.
  119.  
  120.  
  121. Formatting:
  122.  
  123. set left margin         Ctrl Home
  124. set right margin        Ctrl End
  125.     These toggle the margin settings between the current cursor location and the
  126.     screen edge.
  127. set tab width           Alt T
  128.     E will expand all tabs found in files it edits.  If a file read in doesn't
  129.     look right, change the tab width, then read the file in again by pressing
  130.     Alt O and reentering the file name.
  131. wrap paragraph          Alt W
  132.     Readjust line lengths by moving words at the end up or down a line as
  133.     necessary to best fill out the lines within the boundaries set by the left
  134.     and right margins.  Wrapping will start at the beginning of the line the
  135.     cursor is on and stop at the first line on which text does not begin at the
  136.     left margin.  E automatically wraps text as you enter it, moving the first
  137.     word that overflows the right margin down to the beginning of a new line.
  138. toggle autoindent mode  Ctrl @
  139.     Autoindent mode causes each new line after a carriage return to be indented
  140.     as much as the line above it.  The default is on, the way you generally will
  141.     want it for programming.  Turn it off for most word processing except
  142.     writing outlines.
  143. Toggle text/programming mode defaults   Alt Z
  144.     Use this to change quickly between programming and text mode configurations.
  145.     E starts in programming mode with margins at 0, 79 and autoindent on.  ALT
  146.     Z toggles between this and margins at 8, 72 with autoindent mode off for
  147.     processing text.  You may alter E to start up in text mode each time or
  148.     change the default margins using the accompanying configuration program.
  149.  
  150.  
  151. Find and Replace:
  152.  
  153. find                    Alt F *
  154. replace                 Alt R *
  155. find/replace all        Alt A *
  156.     After pressing Alt F and entering a string to find, E will put the cursor
  157.     at the start of the first exact match.  If you then press Alt R, you will
  158.     be prompted for another string to replace the one just found.  Replace must
  159.     always be used immediately after Find.  If the shift key is also pressed,
  160.     the last string entered is used.  Use Find/Replace All only if you're sure
  161.     you want to change all occurrances of a string.  Otherwise use shifted Find
  162.     to locate each subsequent occurrence of a string, then shifted Replace only
  163.     for those instances you want to replace.
  164.  
  165.  
  166. Files and DOS:
  167.  
  168. load other file         Alt O
  169.     Alt O will save the current file if changed and prompt for the name of a
  170.     new file to edit.
  171. save and continue       Alt S
  172. save and exit           Alt X
  173. kill save on exit       Alt K
  174.     Use Alt K before Alt X or Alt O to discard any changes made before exiting.
  175. shell to DOS            F2 *
  176. execute EFn.BAT         F3-F6 *
  177.     Press F2 to exit E temporarily to run some other file or system command
  178.     (for example, DIR).  Type 'exit' after you are done to return to E.  If it
  179.     exists, the batch file EFn.BAT will be executed when Fn is pressed, for n =
  180.     3 to 6.  The file being edited will be saved first if changed.  You can use
  181.     this feature to run a .BAT file to compile, link and/or debug the file you
  182.     are editing, print the file, perhaps passing it to a print formatter such
  183.     as NROFF first, even play a game if you are tired of working, all without
  184.     losing your place!
  185.  
  186.     If the shift key is pressed along with the function key, E contracts itself
  187.     down to under 7K, writing the file being edited to disk if changed, then
  188.     reading it back in afterward.  Anything in the block or other buffers is
  189.     lost.  Use this if the application which you are leaving E to run won't fit
  190.     otherwise.
  191.  
  192.     For example, here is a .BAT file to invoke the Turbo assembler, linker and
  193.     debugger.  If you name it 'EF3.BAT', it will be run whenever you push F3.
  194.     '%1' will be replaced by the name of the file being edited minus any
  195.     extension.
  196.  
  197.         echo off
  198.         tasm -zi %1
  199.         IF ERRORLEVEL 1 GOTO fixit
  200.         tlink /v %1
  201.         IF ERRORLEVEL 1 GOTO fixit
  202.         td %1
  203.         :fixit
  204.  
  205.     If you use one of these functions to invoke an assembler or compiler, I
  206.     recommend you also install a program like BUFFIT to allow you to retrieve
  207.     text that has scrolled off the top of the screen, so you can find those
  208.     error messages once you are back in E.
  209.  
  210.  
  211. I'd like to thank two people who have helped with this project.  Jim DeVries
  212. wrote ECONFIG.EXE, with which you may change many of E's default settings.
  213. Mike Robertson sent me the code to allow E to run under DESQview and
  214. contributed many helpful suggestions as I was developing and debugging E.
  215.  
  216. I'd appreciate hearing about any bugs, and welcome any other comments.  To
  217. contact me, leave mail to dnye on BIX or write me at the address below.  Please
  218. enclose a stamped, self-addressed envelope if you need a reply.
  219.  
  220.  
  221.                                                       David Nye MD
  222.                                                       4209 W Lowe's Creek Rd.
  223.                                                       Eau Claire, WI  54701
  224.                                                       15 Mar, 1990
  225.                                                       BIX name: dnye
  226.  
  227. Version history
  228.  
  229. 0.2, 1 Jan 1990
  230.     First widely released.
  231.  
  232. 0.3, 20 Jan 1990
  233.     Added F2 to execute a DOS command, Alt Z as a quick way to set up word
  234.     processing defaults.  Clearer help screen.  ESC no longer exits (I kept
  235.     hitting it by mistake).  Use Alt X instead.  Some minor bug fixes.  Added
  236.     more color monitor support (default colors, cursor fix).
  237.  
  238. 0.4, 28 Jan 1990
  239.     More bug fixes (last line in file no longer has CR LF appended, can no
  240.     longer start e up without a file name on the command line, then escape out
  241.     of entering a file name at the prompt).  There is now a byte settable with
  242.     debug to start e up in text mode instead of programming mode.  Can enter
  243.     chars above 80h with Shift Alt =.  Wrapping a line ending in one of the
  244.     punctuation characters in the set {.;:!?} leaves two spaces after the
  245.     character.
  246.  
  247. 0.5, 15 Feb 1990
  248.     More minor bug fixes.
  249.  
  250. 0.6, 28 Feb 1990
  251.     Added ability to run under DESQview and F3-F6 functions (to execute BATs).
  252.  
  253. 1.0, 15 Mar 1990
  254.     Bug fixes.  Added shifted F2-F6 functions.